﻿// ———————————————————————–
// <copyright file="UTMCoordinate.cs" company="The MITRE Corporation">
//    Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//    http://www.apache.org/licenses/LICENSE-2.0
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
// </copyright>
// ———————————————————————–
/////////////////////////////////////////////////////////////////////////////////////////////////
// UTMCoordinate.cs:
//
// A data type for a coordinate from the Universal Transverse Mercator (UTM) Coordinate System, which represents a location with a hemisphere, zone, an easting value, and a northing value.
//
// Project: IC.NET - CAD Library
// Author:  Jim Cronin - MITRE
/////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//
// NOTICE
// This software was produced for the U. S. Government
// under Contract No. FA8721-09-C-0001, and is
// subject to the Rights in Noncommercial Computer Software
// and Noncommercial Computer Software Documentation Clause
// (DFARS) 252.227-7014 (JUN 1995)

using System;
using System.Xml;

namespace EDXLSharp.NIEMCore
{
  /// <summary>
  /// A data type for a coordinate from the Universal Transverse Mercator (UTM) Coordinate System, which represents a location with a hemisphere, zone, an easting value, and a northing value.
  /// </summary>
  public class UTMCoordinate : IComposable
  {
    //TODO: UTMCoordinate - Not going to fully expand into ComplexTypeBase implementation at this time - will do later as needed

    /// <summary>
    /// An identifier of a Universal Transverse Mercator coordinate value.
    /// </summary>
    public string Id { get; set; }

    /// <summary>
    /// A distance east within a UTM zone.
    /// </summary>
    public int EastingValue { get; set; }

    /// <summary>
    /// A distance north within a UTM zone.
    /// </summary>
    public int NorthingValue { get; set; }

    /// <summary>
    /// A zone out of the 60 north-south zones in a UTM grid, each covering a strip of the Earth 6 degrees wide in longitude.
    /// </summary>
    public int ZoneId { get; set; }

    /// <summary>
    /// A hemisphere designation for a UTM coordinate.
    /// </summary>
    public HemisphereCode Hemisphere { get; set; }

    /// <summary>
    /// A spatial reference system.
    /// </summary>
    public GeographicDatumText GeographicDatum { get; set; }

    /// <summary>
    /// Writes this Object to an inline XML Document
    /// </summary>
    /// <param name="xwriter">Valid XMLWriter</param>
    /// <exception cref="System.ArgumentNullException">Thrown if xwriter is null</exception>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object fails to validate</exception>
    public void WriteXML(XmlWriter xwriter)
    {
      if (xwriter == null)
      {
        throw new ArgumentNullException("xwriter");
      }

      this.Validate();

      xwriter.WriteStartElement("UTMCoordinate", EDXLConstants.NiemCoreNamespace);
      xwriter.WriteElementString("UTMCoordinateID", EDXLConstants.NiemCoreNamespace, this.Id);
      xwriter.WriteElementString("UTMEastingValue", EDXLConstants.NiemCoreNamespace, this.EastingValue.ToString());
      xwriter.WriteElementString("UTMNorthingValue", EDXLConstants.NiemCoreNamespace, this.NorthingValue.ToString());
      xwriter.WriteElementString("UTMZoneNumeric", EDXLConstants.NiemCoreNamespace, this.ZoneId.ToString());
      xwriter.WriteElementString("UTMHemisphereCode", EDXLConstants.NiemCoreNamespace, this.Hemisphere.GetText());
      GeographicDatum.WriteXML(xwriter);
      xwriter.WriteEndElement();
    }

    /// <summary>
    /// Reads this Object's values from an XML nodelist
    /// </summary>
    /// <param name="rootnode">root XML Node of the Object element</param>
    /// <exception cref="System.ArgumentNullException">Thrown if rootnode is null</exception>
    /// <exception cref="System.ArgumentException">Thrown if the rootnode is not the correct type</exception>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object fails to validate</exception>
    public void ReadXML(XmlNode rootnode)
    {
      if (rootnode == null)
      {
        throw new ArgumentNullException("rootnode");
      }
      if (rootnode.LocalName != "UTMCoordinate")
      {
        throw new ArgumentException("Unexpected element " + rootnode.LocalName + " instead of UTMCoordinate");
      }

      foreach (XmlNode node in rootnode.ChildNodes)
      {
        switch (node.LocalName)
        {
          case "UTMCoordinateID":
            this.Id = node.InnerText;
            break;
          case "UTMEastingValue":
            int eval;
            if (!int.TryParse(node.InnerText, out eval))
            {
              throw new ValidationException("Easting Value must be a non-negative integer");
            }
            this.EastingValue = eval;
            break;
          case "UTMNorthingValue":
            int nval;
            if (!int.TryParse(node.InnerText, out nval))
            {
              throw new ValidationException("Northing Value must be a non-negative integer");
            }
            this.NorthingValue = nval;
            break;
          case "UTMZoneNumeric":
            int zval;
            if (!int.TryParse(node.InnerText, out zval))
            {
              throw new ValidationException("ZoneId number must be between 1 and 60 (inclusive)");
            }
            this.ZoneId = zval;
            break;
          case "GeographicDatumText":
            this.GeographicDatum = new GeographicDatumText();
            this.GeographicDatum.ReadXML(node);
            break;
          default:
            this.Hemisphere = HemisphereCodeExtensions.GetCode(node.InnerText);
            break;
        }
      }

      this.Validate();
    }

    /// <summary>
    /// Validates This Message element For Required Values and Conformance
    /// </summary>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object fails to validate</exception>
    public void Validate()
    {
      if (string.IsNullOrEmpty(Id))//TODO: UTMCoorindate.Validate - valid/invalid values for ID?
      {
        throw new ValidationException("Missing required field Id");
      }
      if (EastingValue < 0)
      {
        throw new ValidationException("Easting Value must be a non-negative integer");
      }

      if (NorthingValue < 0)
      {
        throw new ValidationException("Northing Value must be a non-negative integer");
      }

      if (ZoneId < 1 || ZoneId > 60)
      {
        throw new ValidationException("ZoneId must be between 1 and 60 (inclusive)");
      }

      if (GeographicDatum == null)
      {
        throw new ValidationException("Missing required field GeographicDatumText");
      }
      GeographicDatum.Validate();
    }
  }
}